🤖 Clarify workspace ID vs name vs path architecture #420
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated config.ts to clarify generateWorkspaceId is ONLY for legacy support - Fixed debug/git-status.ts to not suggest project-branch ID format - Updated App.stories.tsx mock IDs to use stable ID format (10 hex chars) - Added clarifying comments to E2E test fixtures - Documented that workspace IDs must come from backend, never constructed in frontend The generateWorkspaceId method is kept for: - Legacy workspace lookup (users may have old workspaces) - E2E test backward compatibility - Debug script legacy support
Debug commands are internal dev tools and don't need backward compatibility. - debug/list-workspaces.ts: Display actual workspace ID from config instead of generating legacy IDs - debug/agentSessionCli.ts: Require --workspace-id instead of deriving from project path This eliminates any suggestion that workspace IDs can be constructed from project/branch names.
Makes the legacy-only purpose explicit in the method name. - Renamed method in Config class - Updated all call sites in config.ts (4 locations) - Updated E2E test fixtures - Updated config.test.ts All tests pass.
Fixes terminology and documentation inconsistencies that could mislead contributors about workspace identity, directory naming, and path construction. Changes: - Renamed config.getWorkspacePath parameter from 'workspaceId' to 'directoryName' to reflect that it accepts workspace.name (branch name), not the stable ID - Updated 'Workspace Path Architecture' docs in config.ts to clearly separate: • Worktree directory name: uses workspace.name (branch name) • Workspace ID: stable random identifier for identity and sessions - Renamed CreateWorktreeOptions.workspaceId → directoryName in git.ts - Removed outdated 'symlink' references across components, types, and tests (worktree directories now use workspace names directly, no symlinks) - Updated App.stories.tsx fixtures to use hex-like IDs (e.g., '1a2b3c4d5e') instead of 'project-branch' format to match production ID generation All changes are documentation, comments, parameter names, and test fixtures. No functional changes to runtime behavior.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes terminology inconsistencies that could mislead contributors about workspace identity vs directory naming.
Changes
Parameter renaming:
config.getWorkspacePath(workspaceId)→getWorkspacePath(directoryName)CreateWorktreeOptions.workspaceId→directoryNameDocumentation:
Test fixtures:
1a2b3c4d5e) matching production formatAll changes are non-functional: comments, docs, parameter names, and test fixtures only.
Generated with
cmux